home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / archie.zip / ARCHIE.MAN < prev    next >
Text File  |  1991-11-22  |  7KB  |  225 lines
  1. .\" Originally by Jeff Kellem
  2. .\"
  3. .TH ARCHIE 1 "20 November 1991" "Archie (Prospero)"
  4. .SH NAME
  5. archie \- query the Archie anonymous FTP databases using Prospero
  6. .SH SYNOPSIS
  7. .in +\w'\fBarchie \fR'u
  8. .ti -\w'\fBarchie \fR'u
  9. .B archie\
  10. \ [\ \fB\-cers\fR\ ]\
  11. \ [\ \fB\-l\fR\ ]\ [\ \fB\-t\fR\ ]\
  12. \ [\ \fB\-m#\fR\ ]\ [\ \fB\-N#\fR\ ]\
  13. \ [\ \fB\-h\fR\ \fIhost\fR\ ]\ [\ \fB\-L\fR\ ]\ \fIstring\fR
  14. .SH DESCRIPTION
  15. .B archie
  16. queries an archie anonymous FTP database looking for the specified
  17. .I string
  18. using the
  19. .B Prospero
  20. protocol.  This client is based on
  21. .B Prospero
  22. version Beta.4.2 and is provided to encourage non-interactive use of
  23. the Archie servers (and subsequently better performance on both
  24. sides).
  25.  
  26. The general method of use is of the form
  27.  
  28. .RS
  29. %
  30. .B archie string
  31. .RE
  32. .PP
  33.  
  34. This will go to the archie server and ask it to look for all known
  35. systems that have a file named `string' in their FTP area.  \fBarchie\fP
  36. will wait, and print out any matches.
  37.  
  38. For example,
  39.  
  40. .RS
  41. %
  42. .B archie emacs
  43. .RE
  44. .PP
  45.  
  46. will find all anonymous FTP sites in the archie database that have files
  47. named
  48. .B emacs
  49. somewhere in their FTP area.  (This particular query would probably
  50. return a lot of directories.)  If you want a list of every filename
  51. that contains \fBemacs\fR \fIanywhere\fR in it, you'd use
  52.  
  53. .RS
  54. %
  55. .B archie -c emacs
  56. .RE
  57. .PP
  58.  
  59. Regular expressions, such as
  60.  
  61. .RS
  62. %
  63. .B archie -r '[xX][lL]isp'
  64. .RE
  65. .PP
  66.  
  67. may also be used for searches.  (See the manual of a reasonably good
  68. editor, like GNU Emacs or vi, for more information on using regular
  69. expressions.)
  70.  
  71. .SH OPTIONS
  72. The options currently available to this
  73. .B archie
  74. client are:
  75.  
  76. .PD 0
  77. .TP 12
  78. .BR \-c
  79. Search substrings paying attention to upper & lower case.
  80. .TP
  81. .BR \-e
  82. Exact string match.  (This is the default.)
  83. .TP
  84. .BR \-r
  85. Search using a regular expression.
  86. .TP
  87. .BR \-s
  88. Search substrings ignoring the case of the letters.
  89. .TP
  90. .BR \-l
  91. Output results in a form suitable for parsing by programs.
  92. .TP
  93. .BR \-t
  94. Sort the results inverted by date.
  95. .TP
  96. .BI \-m#
  97. Specifies the maximum number of hits (matches) to return (default of 
  98. \fB95\fR).
  99. .TP
  100. .BI \-N#
  101. Sets the \fIniceness\fR of a query; by default, it's set to 0.
  102. Without an argument, \fB\-N\fR defaults to \fB35765\fR.  If you use
  103. \fB\-N\fR with an argument between 0 and 35765, it'll adjust itself
  104. accordingly.  (\fBNote\fR: VMS users will have to put quotes around
  105. this argument, and \fB\-L\fR, like ``\fB\-N45\fR''; VMS will otherwise convert
  106. it to lowercase.)
  107. .TP
  108. .BI \-h\ \fIhost\fR
  109. Tells the client to query the Archie server named \fIhost\fR.
  110. .TP
  111. .BI \-L
  112. Lists the Archie servers known to the program when it was compiled.
  113. .TP
  114. .BI \-H\ \fIconfigfile\fR
  115. (DOS ONLY) Tells Archie where to find the config.tel file, if not in the
  116. current directory, and not set in the DOS environment variable \fBCONFIGTEL\fR.
  117.  
  118. .PP
  119.  
  120. .SS Quick Hits
  121. You'll often find yourself making fast and furious queries for
  122. multiple things that all look similar (e.g. `telnet', `net', etc).  If
  123. you get into the habit of using the
  124. .BR \-c
  125. option when performing these kinds of searches, they'll often prove
  126. more fruitful than if you relied upon the default of
  127. .BR \-e .
  128.  
  129. .SS Notes
  130. The three search-modifying arguments (\fB\-c\fR, \fB\-r\fB, and \fB\-s\fR)
  131. are all mutually exclusive; only the last one counts.  If you specify
  132. \fB\-e\fR with any of \fB\-c\fR, \fB\-r\fB, or \fB\-s\fR,
  133. the server will first check for an exact match, then fall back to the
  134. case-sensitive, case-insensitive, or regular expression search.  This is
  135. so if there are matches that are particularly obvious, it will take a
  136. minimal amount of time to satisfy your request.
  137.  
  138. If you list a single `\-' by itself, any further arguments will be
  139. taken as part of the search string.  This is intended to enable
  140. searching for strings that begin with a `\-'; for example:
  141.  
  142. .RS
  143. %
  144. .B archie \-s \- \-old
  145. .RE
  146.  
  147. will search for all filenames that contain the string `\-old' in them.
  148.  
  149. .SH RESPONSE
  150. Archie servers are set up to respond to a number of requests in a
  151. queued fashion.  That is, smaller requests get served much more
  152. quickly than do large requests.  As a result, the more often you query
  153. the Archie server, or the larger your requests, the longer the queue
  154. will become, resulting in a longer waiting period for everyone's
  155. requests.  Please be frugal when possible, for your benefit as well as
  156. for the other users.
  157.  
  158. .SH QUERY PRIORITY
  159. Please use the \fB\-N\fR option whenever you don't demand immediacy, or
  160. when you're requesting things that could generate large responses.
  161. Even when using the nice option, you should still try to avoid big
  162. jobs during busy periods.  Here is a list of what we consider to be
  163. nice values that accurately reflect the priority of a job to the server.
  164.  
  165. .RS
  166. .TP 20
  167. .B Normal
  168. 0
  169. .TP
  170. .B Nice
  171. 500
  172. .TP
  173. .B Nicer
  174. 1000
  175. .TP
  176. .B Very Nice
  177. 5000
  178. .TP
  179. .B Extremely Nice
  180. 10000
  181. .TP
  182. .B Nicest
  183. 32765
  184. .RE
  185.  
  186. The last priority, \fBNicest\fR, would be used when a job should wait until
  187. the queue is essentially empty before running.  You should pick one of
  188. these values to use, possibly modifying it slightly depending on where
  189. you think your priority should land.  For example, 32760 would mean
  190. wait until the queue is empty, but jump ahead of other jobs that have
  191. selected \fBNicest\fR.
  192.  
  193. There are certain types of things that we suggest using \fBNicest\fR
  194. for, irregardless.  In particular, any searches for which you would
  195. have a hard time justifying the use of anything but extra resources.
  196. (We all know what those searches would be for.)
  197.  
  198. .SH SEE ALSO
  199. For more information on regular expressions, see the manual pages on:
  200.  
  201. .BR regex (3) ,
  202. .BR ed (1)
  203.  
  204. Also read the file \fBarchie/whatis\fR on \fBarchie.mcgill.ca\fR for a
  205. detailed paper on Archie as a whole.
  206.  
  207. .SH AUTHORS
  208. The 
  209. .B archie
  210. service was conceived and implemented by Alan Emtage (\fBbajan@cs.mcgill.ca\fR),
  211. Peter Deutsch (\fBpeterd@cs.mcgill.ca\fR), and Bill Heelan
  212. (\fBwheelan@cs.mcgill.ca\fR).  The entire Internet is in their debt.
  213.  
  214. The \fBProspero\fR system was created by Clifford Neuman
  215. (\fBbcn@isi.edu\fR); write to \fBinfo\-prospero@isi.edu\fR for more
  216. information on the protocol and its use.
  217.  
  218. This stripped client was put together by Brendan Kehoe
  219. (\fBbrendan@cs.widener.edu\fR), with modifications by
  220. Clifford Neuman and George Ferguson (\fBferguson@cs.rochester.edu\fR).
  221.  
  222. .SH BUGS
  223. There are none; only a few unexpected features.
  224.  
  225.